The vive_3dsp_room structure represents the 3D room model, including the reflection and reverberation effects.
More...
#include <vive_3dsp_api/room.h>
|
(Note that these are not member functions.)
|
| vive_3dsp_room * | vive_3dsp_room_create_object (vive_3dsp_context *api) |
| |
| VIVE_3DSP_API_STATUS | vive_3dsp_room_destroy_object (vive_3dsp_context *api, vive_3dsp_room *room) |
| |
| VIVE_3DSP_API_STATUS | vive_3dsp_room_set_size (vive_3dsp_context *api, vive_3dsp_room *room, VIVE_3DSP_Vector3 size) |
| |
| VIVE_3DSP_API_STATUS | vive_3dsp_room_set_position (vive_3dsp_context *api, vive_3dsp_room *room, VIVE_3DSP_Vector3 pos) |
| |
| VIVE_3DSP_API_STATUS | vive_3dsp_room_set_rotation (vive_3dsp_context *api, vive_3dsp_room *room, VIVE_3DSP_Quaternion rot) |
| |
| VIVE_3DSP_API_STATUS | vive_3dsp_room_set_material (vive_3dsp_context *api, vive_3dsp_room *room, VIVE_3DSP_ROOM_PLANE room_plane, VIVE_3DSP_REVERB_MATERIAL room_material) |
| |
| VIVE_3DSP_API_STATUS | vive_3dsp_room_set_reverb_preset (vive_3dsp_context *api, vive_3dsp_room *room, VIVE_3DSP_ROOM_REVERB_PRESET room_reverb_preset) |
| |
| VIVE_3DSP_API_STATUS | vive_3dsp_room_set_reflection (vive_3dsp_context *api, vive_3dsp_room *room, VIVE_3DSP_ROOM_PLANE room_plane, float rate) |
| |
| VIVE_3DSP_API_STATUS | vive_3dsp_room_set_gain (vive_3dsp_context *api, vive_3dsp_room *room, float gain) |
| |
| VIVE_3DSP_API_STATUS | vive_3dsp_room_enable (vive_3dsp_context *api, vive_3dsp_room *room, bool enable) |
| |
| VIVE_3DSP_API_STATUS | vive_3dsp_room_setDryLevel (vive_3dsp_context *api, vive_3dsp_room *room, float level_dB) |
| |
| VIVE_3DSP_API_STATUS | vive_3dsp_room_setReflectionLevel (vive_3dsp_context *api, vive_3dsp_room *room, float level_dB) |
| |
| VIVE_3DSP_API_STATUS | vive_3dsp_room_setReverbLevel (vive_3dsp_context *api, vive_3dsp_room *room, float level_dB) |
| |
| VIVE_3DSP_API_STATUS | vive_3dsp_room_set_property (vive_3dsp_context *api, vive_3dsp_room *room, VIVE_3DSP_ROOM_PROPERTY prop) |
| |
| float * | vive_3dsp_room_get_bgaudio (vive_3dsp_context *api, int id) |
| |
| VIVE_3DSP_API_STATUS | vive_3dsp_room_free_bgaudio (vive_3dsp_context *api, float *pBgaudio) |
| |
The vive_3dsp_room structure represents the 3D room model, including the reflection and reverberation effects.
- Examples:
- Example.cpp.
◆ vive_3dsp_room_create_object()
Create a room object in the specific audio engine.
- Parameters
-
| api | The audio engine object. |
- Returns
- A room object.
◆ vive_3dsp_room_destroy_object()
Destroy a room object in the specific audio engine.
- Parameters
-
- Returns
- Status code indicating whether or not the operation succeeded.
◆ vive_3dsp_room_enable()
Enable or disable room effect of all audio source objects.
- Parameters
-
| api | The audio engine object. |
| room | The room object created by vive_3dsp_room_create_object. |
| enable | Set true to enable the effect. Otherwise, set false. |
- Returns
- Status code indicating whether or not the operation succeeded.
◆ vive_3dsp_room_free_bgaudio()
| VIVE_3DSP_API_STATUS vive_3dsp_room_free_bgaudio |
( |
vive_3dsp_context * |
api, |
|
|
float * |
pBgaudio |
|
) |
| |
|
related |
Set the level of the background audio signal.
- Parameters
-
| api | The audio engine object. |
| pBgaudio | Background audio data. |
- Returns
- Status code indicating whether or not the operation succeeded.
◆ vive_3dsp_room_get_bgaudio()
Set the level of the background audio signal.
- Parameters
-
- Returns
- 1 second background audio data in 48000 Hz sample rate, 16-bit resolution.
◆ vive_3dsp_room_set_gain()
Set output gain of the room effect.
- Parameters
-
| api | The audio engine object. |
| room | The room object created by vive_3dsp_room_create_object. |
| gain | Output gain. It should be nonnegative and in linear scale. |
- Returns
- Status code indicating whether or not the operation succeeded.
◆ vive_3dsp_room_set_material()
| VIVE_3DSP_API_STATUS vive_3dsp_room_set_material |
( |
vive_3dsp_context * |
api, |
|
|
vive_3dsp_room * |
room, |
|
|
VIVE_3DSP_ROOM_PLANE |
room_plane, |
|
|
VIVE_3DSP_REVERB_MATERIAL |
room_material |
|
) |
| |
|
related |
Set the materials of all the surfaces around the room.
- Parameters
-
- Returns
- Status code indicating whether or not the operation succeeded.
◆ vive_3dsp_room_set_position()
Set the room position. It is expressed as the centroid of the room.
- Parameters
-
| api | The audio engine object. |
| room | The room object created by vive_3dsp_room_create_object. |
| pos | The position of the room along with x, y, and z axis. |
- Returns
- Status code indicating whether or not the operation succeeded.
◆ vive_3dsp_room_set_property()
Set room properties.
- Parameters
-
- Returns
- Status code indicating whether or not the operation succeeded.
◆ vive_3dsp_room_set_reflection()
Set the reflection rates of all the surfaces around the room.
- Parameters
-
| api | The audio engine object. |
| room | The room object created by vive_3dsp_room_create_object. |
| room_plane | Specify the surface you want to set. It can be ROOM_FLOOR, ROOM_CEILING, and ROOM_WALL. |
| rate | The reflection rate. The value 0 represents perfect absortion and 1 is perfect reflection. |
- Returns
- Status code indicating whether or not the operation succeeded.
◆ vive_3dsp_room_set_reverb_preset()
Set the preset of the room reverb.
- Parameters
-
◆ vive_3dsp_room_set_rotation()
Set the room rotation.
- Parameters
-
- Returns
- Status code indicating whether or not the operation succeeded.
◆ vive_3dsp_room_set_size()
Set the room size. So far the room is expressed as a cube.
- Parameters
-
| api | The audio engine object. |
| room | The room object created by vive_3dsp_room_create_object. |
| size | The size of the room along with x, y, and z axis. |
- Returns
- Status code indicating whether or not the operation succeeded.
◆ vive_3dsp_room_setDryLevel()
Set the level of the dry signal.
- Parameters
-
- Returns
- Status code indicating whether or not the operation succeeded.
◆ vive_3dsp_room_setReflectionLevel()
Set the level of the early reflection signal.
- Parameters
-
- Returns
- Status code indicating whether or not the operation succeeded.
◆ vive_3dsp_room_setReverbLevel()
Set the level of the revereration signal.
- Parameters
-
- Returns
- Status code indicating whether or not the operation succeeded.
The documentation for this struct was generated from the following file: